kvgraph

kvgraph

A graph that you can add elements to with key and value. Edges are detected via links in values to other keys. You can perform computation on the graph using reduce functions.

var KVGraph = require('kvgraph')

var graph = new KVGraph()

graph.add(key, value)

Add an item to the graph. The graph is considered immutable, so a value can only be set once for a key. key should be a string. value may be any type. Any property of value will be indexed as potentially a link to another value.

graph.reduce(fn) : value

• fn(states, object) : state

Compute a reduce on the elements in the graph, in no particular order. Use if your function is commutative.

fn gets called for each object in the graph. states is an array of previously reduced values that the current object links to (or is linked to by, in the case of reduceRight). The return value of fn goes into states for the next objects. object will be undefined when computing the final reduce value.

graph.reduceLeft(fn) : value

Compute a reduce on the elements in the graph. It is a left reduce so you can use it with a left-associative function.

graph.reduceRight(fn) : value

Same as reduceLeft, except it is a right-reduce so fn should be a right-associative function.

graph.getRoots() : object

Get the roots of the graph - elements that don't link to any other elements. Returns an object where the keys are object keys.

graph.getHeads() : object

Get the heads of the graph - elements that are not linked to by other elements. Returns an object where the keys are object keys.

License

Copyright (c) 2016 Charles Lehner

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.